Documentation for Users  2.0.6
Perception Toolbox for Virtual Reality (PTVR) Manual
VisualScene Class Reference
+ Inheritance diagram for VisualScene:

Public Member Functions

def __init__ (self, trial=-1, background_color=color.RGBColor(0.6, 0.6, 0.6, 1), are_both_hand_controllers_visible=False, is_left_hand_controller_visible=False, is_right_hand_controller_visible=False, is_left_hand_visible=False, is_right_hand_visible=False, skybox="", global_lights_intensity=0, ambient_light_color=np.array([1, 1, 1]), objects_emit_light=True, side_view_on_pc=False, augmented_vision=False)
 
def place (self, visual_object, the_3D_world)
 
def placeUI (self, o)
 
def to_json (self)
 
def set_augmented_vision (self)
 
def write (self, fp)
 
def AddInteraction (self, events=[], callbacks=[])
 
def AddPointingCursor (self, pointingCursor)
 
def place_contingent_cursor (self, pointingCursor)
 
def place_pointing_laser (self, pointingCursor)
 
def fill_in_results_file_column (self, column_name, value)
 

Data Fields

 objects
 
 UIobjects
 
 type
 
 on_loaded_event
 
 augmented_vision
 
 objects_emit_light
 
 isLeftControllerVisibility
 
 isRightControllerVisibility
 
 isLeftHandVisibility
 
 isRightHandVisibility
 
 leftBackgroundColor
 
 rightBackgroundColor
 
 interaction
 
 pointingCursors
 
 id
 
 trial
 
 origin
 
 originIsSet
 
 skybox
 
 global_lights_intensity
 
 ambient_light_color
 
 side_view_on_pc
 
 fillInResultsFileColumnString
 

Private Member Functions

def _pickle_object (self, o, pos, rot)
 

Detailed Description

Parameters
----------
trial :  The default is -1.
background_color :The default is color.RGBColor(0.6, 0.6, 0.6, 1).

skybox : "Night", "BrightMorning", "Cloudy", "Afternoon", "Sunset", "MilkyWay"
    DESCRIPTION. 
    The default is "".

global_lights_intensity : number from zero to undefined upper limit (as in Unity).
    Six sources of light are placed above the XZ plane (and approximately
    above the origin)   
    to induce some strong shading of the objects in a scene. This is
    helpful for instance to clearly see the sides of an object such as a
    cube, especially for demos where shapes are not too far from the origin.
    
    It is independent of whether 'skybox' has been set to one of its 
    possible arguments.   
    
    The default is 1.

ambient_light_color: a triplet of red, green and blue values.
    This is the color of an ambient  DIFFUSE light.
    (cf "ambient light" in Unity documentation)
    The default is np.array([1, 1, 1])  

objects_emit_light: True of False.
    it is a mode in which all objects emit light, ie objects can be
    seen without any light source in the scene.
    (cf EMISSION mode in Unity).
    The default is True.

side_view_on_pc : True of False.
    DESCRIPTION. When True, the PTVR window (on your PC) will show you 
    a "side view". 
    This is as if the PTVR window showed the view from a camera looking
    laterally at your subject (at its headset actually). 
    You can rotate this view with your mouse.
    This is convenient for didactic purposes.
    The default is False.

Returns
-------
None.

Definition at line 109 of file Scenes.py.


The documentation for this class was generated from the following file: